Description

What is an API?

  • Types of APIs
  • Examples of APIs
  • How REST and other APIs work

Using an API

  • Authentication and accreditation

The audience for API documentation

  • What do they want?
  • Who uses API documentation?

What documentation should I write?

  • What content goes into an API document?
  • The twelve types of documents for developers that Google recommends
  • Common structures for developer portals
  • Automatically generated content
  • Manually written content
  • Writing the content
  • Code samples
  • Onboarding

Design patterns in developer portals

  • Standards and conventions
  • Designing the content to meet the audience’s needs

Authoring tools

  • Creating content
  • API Specification tools
  • Automation tools

 

Specifications

  • Free Demo
  • Missed Class Recovery
  • Free Access to Tools
  • Certification by Institute
  • Instalment Facility
  • Master the concepts of Software and API  
  • Types of API  
  • RESTful API  
  • Advantages of RESTful APIs  
  • CURD operation  
  • How API works  
  • API Documentation process  
  • API template  
  • API with Swagger 

Ms Anupama

An accomplished Trainer with 20 plus years of working experience with global IT companies.
Delivered trainings on topics like Technical Writing, XML/DITA, Agile Methodology, Business Proposal Writing, Whitepaper and more. Handle Corporate, classroom and online training. She has trained many candidates and placed them in companies like Honeywell, IBM, CISCO, Triamps, Wipro, Accenture, Integra, Oracle, Aditi etc. 
During more than 15 years of technical writing, she has developed Style guide, Training manuals, API documents, User Guides, Release notes, Admin Guide, Instructional guides’ Product Proposals and online help files. Hands on Technical Editing, Review and Proofread. Worked on DITA, XML migration, She works on Technical Content Writing as well.


 

5

1

4

3

2

1

Batch Start Date End Date Timings Batch Type
No video found

Description

What is an API?

  • Types of APIs
  • Examples of APIs
  • How REST and other APIs work

Using an API

  • Authentication and accreditation

The audience for API documentation

  • What do they want?
  • Who uses API documentation?

What documentation should I write?

  • What content goes into an API document?
  • The twelve types of documents for developers that Google recommends
  • Common structures for developer portals
  • Automatically generated content
  • Manually written content
  • Writing the content
  • Code samples
  • Onboarding

Design patterns in developer portals

  • Standards and conventions
  • Designing the content to meet the audience’s needs

Authoring tools

  • Creating content
  • API Specification tools
  • Automation tools

 

Specifications

  • Free Demo
  • Missed Class Recovery
  • Free Access to Tools
  • Certification by Institute
  • Instalment Facility

Comments (1)

Prashanth V

March 28, 2022 12:47:26pm

Thank you so much for your valuable training. Anupama mam is a very good trainer, friendly and encouraging. Her explanation were easy to understand. She makes sure that all concepts are understood well and clears all the related doubts.

Comment

Please login to leave a review

Related Classes